<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.10"/>
<title>ESP8266_RTOS_SDK: User IE APIs</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">ESP8266_RTOS_SDK
   &#160;<span id="projectnumber">v1.4.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">User IE APIs<div class="ingroups"><a class="el" href="group__WiFi__APIs.html">WiFi Related APIs</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>WiFi User IE APIs.  
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga48a93836b1b5d84a69592b90613cf01f"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__WiFi__User__IE__APIs.html#ga48a93836b1b5d84a69592b90613cf01f">user_ie_manufacturer_recv_cb_t</a>) (user_ie_type type, const uint8 sa[6], const uint8 m_oui[3], uint8 *ie, uint8 ie_len, sint32 rssi)</td></tr>
<tr class="memdesc:ga48a93836b1b5d84a69592b90613cf01f"><td class="mdescLeft">&#160;</td><td class="mdescRight">User IE received callback.  <a href="#ga48a93836b1b5d84a69592b90613cf01f">More...</a><br /></td></tr>
<tr class="separator:ga48a93836b1b5d84a69592b90613cf01f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga458e8a42e01e31a1d11dabced27f848f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga458e8a42e01e31a1d11dabced27f848f"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>user_ie_type</b> { <br />
&#160;&#160;<b>USER_IE_BEACON</b> = 0, 
<b>USER_IE_PROBE_REQ</b>, 
<b>USER_IE_PROBE_RESP</b>, 
<b>USER_IE_ASSOC_REQ</b>, 
<br />
&#160;&#160;<b>USER_IE_ASSOC_RESP</b>, 
<b>USER_IE_MAX</b>
<br />
 }<tr class="separator:ga458e8a42e01e31a1d11dabced27f848f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaae332b9c26be88e95787a825f828c827"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__WiFi__User__IE__APIs.html#gaae332b9c26be88e95787a825f828c827">wifi_set_user_ie</a> (bool enable, uint8 *m_oui, user_ie_type type, uint8 *user_ie, uint8 len)</td></tr>
<tr class="memdesc:gaae332b9c26be88e95787a825f828c827"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set user IE of ESP8266.  <a href="#gaae332b9c26be88e95787a825f828c827">More...</a><br /></td></tr>
<tr class="separator:gaae332b9c26be88e95787a825f828c827"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaef66bcf79ecaaf03da9c9f1a484b192f"><td class="memItemLeft" align="right" valign="top">sint32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__WiFi__User__IE__APIs.html#gaef66bcf79ecaaf03da9c9f1a484b192f">wifi_register_user_ie_manufacturer_recv_cb</a> (<a class="el" href="group__WiFi__User__IE__APIs.html#ga48a93836b1b5d84a69592b90613cf01f">user_ie_manufacturer_recv_cb_t</a> cb)</td></tr>
<tr class="memdesc:gaef66bcf79ecaaf03da9c9f1a484b192f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register user IE received callback.  <a href="#gaef66bcf79ecaaf03da9c9f1a484b192f">More...</a><br /></td></tr>
<tr class="separator:gaef66bcf79ecaaf03da9c9f1a484b192f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8f1e33403097564f724cc7d5115d2ab4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__WiFi__User__IE__APIs.html#ga8f1e33403097564f724cc7d5115d2ab4">wifi_unregister_user_ie_manufacturer_recv_cb</a> (void)</td></tr>
<tr class="memdesc:ga8f1e33403097564f724cc7d5115d2ab4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unregister user IE received callback.  <a href="#ga8f1e33403097564f724cc7d5115d2ab4">More...</a><br /></td></tr>
<tr class="separator:ga8f1e33403097564f724cc7d5115d2ab4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>WiFi User IE APIs. </p>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="ga48a93836b1b5d84a69592b90613cf01f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef void(* user_ie_manufacturer_recv_cb_t) (user_ie_type type, const uint8 sa[6], const uint8 m_oui[3], uint8 *ie, uint8 ie_len, sint32 rssi)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>User IE received callback. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">user_ie_type</td><td>type : type of user IE. </td></tr>
    <tr><td class="paramname">const</td><td>uint8 sa[6] : source address of the packet. </td></tr>
    <tr><td class="paramname">const</td><td>uint8 m_oui[3] : factory tag. </td></tr>
    <tr><td class="paramname">uint8</td><td>*user_ie : pointer of user IE. </td></tr>
    <tr><td class="paramname">uint8</td><td>ie_len : length of user IE. </td></tr>
    <tr><td class="paramname">sint32</td><td>rssi : signal strength.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>null </dd></dl>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gaef66bcf79ecaaf03da9c9f1a484b192f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">sint32 wifi_register_user_ie_manufacturer_recv_cb </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__WiFi__User__IE__APIs.html#ga48a93836b1b5d84a69592b90613cf01f">user_ie_manufacturer_recv_cb_t</a>&#160;</td>
          <td class="paramname"><em>cb</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Register user IE received callback. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">user_ie_manufacturer_recv_cb_t</td><td>cb : callback</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 : succeed </dd>
<dd>
-1 : fail </dd></dl>

</div>
</div>
<a class="anchor" id="gaae332b9c26be88e95787a825f828c827"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool wifi_set_user_ie </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>enable</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8 *&#160;</td>
          <td class="paramname"><em>m_oui</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">user_ie_type&#160;</td>
          <td class="paramname"><em>type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8 *&#160;</td>
          <td class="paramname"><em>user_ie</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8&#160;</td>
          <td class="paramname"><em>len</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set user IE of ESP8266. </p>
<p>The user IE will be added to the target packets of user_ie_type.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">bool</td><td>enable :<ul>
<li>true, enable the corresponding user IE function, all parameters below have to be set.</li>
<li>false, disable the corresponding user IE function and release the resource, only the parameter "type" below has to be set. </li>
</ul>
</td></tr>
    <tr><td class="paramname">uint8</td><td>*m_oui : factory tag, apply for it from Espressif System. </td></tr>
    <tr><td class="paramname">user_ie_type</td><td>type : IE type. If it is USER_IE_BEACON, please disable the IE function and enable again to take the configuration effect immediately . </td></tr>
    <tr><td class="paramname">uint8</td><td>*user_ie : user-defined information elements, need not input the whole 802.11 IE, need only the user-define part. </td></tr>
    <tr><td class="paramname">uint8</td><td>len : length of user IE, 247 bytes at most.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true : succeed </dd>
<dd>
false : fail </dd></dl>

</div>
</div>
<a class="anchor" id="ga8f1e33403097564f724cc7d5115d2ab4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void wifi_unregister_user_ie_manufacturer_recv_cb </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Unregister user IE received callback. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">null</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>null </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Mar 1 2016 10:19:26 for ESP8266_RTOS_SDK by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.10
</small></address>
</body>
</html>
